home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / utility / btoa52.zip / BTOA.DOC < prev    next >
Text File  |  1994-04-08  |  4KB  |  133 lines
  1.  
  2.  
  3.  
  4. BTOA(1)                  USER COMMANDS                    BTOA(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      btoa - encode/decode binary to printable ASCII
  10.  
  11. SYNOPSIS
  12.      btoa -adhor input filename output filename
  13.  
  14. DESCRIPTION
  15.      Btoa is a filter which reads binary  bytes  from  the  input
  16.      file  and generates printable ASCII characters on the output
  17.      file. It attaches a header and a checksum to the archive. It
  18.      can  also  reverse  this,  creating  a  binary file from the
  19.      archive.
  20.  
  21.      Since last version of btoa/atob, several new  features  have
  22.      been  added.  The  most  obvious  one  is that atob has been
  23.      integrated with btoa. They are now the same program which is
  24.      called  with  different arguments. Another is the ability to
  25.      repair damaged archives.
  26.  
  27.      The new version is compatible with the old version, that is,
  28.      it can still encode and decode old btoa files.
  29.  
  30.      Btoa has an option to  decode  the  archive,  restoring  the
  31.      binary  bytes.   It  strips  the input file until it finds a
  32.      valid header, and continues decoding until the end  mark  is
  33.      found.  It  recognices  both old- and new-style headers, and
  34.      can decode both. It is possible to leave out the destination
  35.      name  when  decoding new-style archives, because the name is
  36.      stored in the header. Entering  a  name  will  override  the
  37.      autonaming function.
  38.  
  39.      It is possible to leave out  the  file  names  and  redirect
  40.      stdin and stdout with '<' and '>' to the desired files. This
  41.      is to maintain compatibility with earlier versions of btoa.
  42.  
  43.      Btoa now adds a single byte checksum  to  each  row  in  the
  44.      archive.   When  an  error is found, diagnosis automatically
  45.      starts and produces a diagnosis file which can  be  used  to
  46.      extract  the  damaged  part  from  an errorfree archive. The
  47.      extracted part can then  be  used  to  correct  the  damaged
  48.      archive.    Btoa  has  options  to  perform  the  reparation
  49.      automatically. This is especially  useful  when  downloading
  50.      data  converted to text files, and occasionally finding that
  51.      an archive file of considerable size turns is corrupted.
  52.  
  53. FEATURES
  54.      Btoa encodes 4 binary bytes into 5 characters, expanding the
  55.      file  by  25%. As a special case 4 zeroes will be encoded as
  56.      'z' and 4 spaces as 'y'. This makes it possible to  compress
  57.      the archive a bit.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                   Last change: 21 February 1989                 1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. BTOA(1)                  USER COMMANDS                    BTOA(1)
  71.  
  72.  
  73.  
  74. OPTIONS
  75.      -h   Shows help on btoa.
  76.  
  77.      -a   Switches to atob (decoding) mode.
  78.  
  79.      -o   Switches to old version of btoa.
  80.  
  81.      -d   Extracts repair file from diagnosis file. This  assumes
  82.           that  an  undamaged  version  of the archive and a file
  83.           called
  84.  
  85.      -r   Repairs the damaged archive. A  file  named  'btoa.rep'
  86.           must be present for this to work.
  87.  
  88. EXAMPLES
  89.      Below follows a description  of  a  normal  repair  session.
  90.      Lines  beginning with 'Local>' were typed on the computer to
  91.      which the file was downloaded. Accordingly, lines  typed  on
  92.      the  connected computer will begin with 'Remote>'. Sending a
  93.      file to the other computer will be noted as 'transmit file'.
  94.  
  95.      A normal repairing procedure is as follows: Local>  btoa  -a
  96.      file.btoa  btoa:  Bad checksum on line 2648.  btoa: Starting
  97.      diagnosis.  btoa: Diagnosis output  to  'btoa.dia'.   Local>
  98.      transmit btoa.dia
  99.  
  100.      Remote> btoa -d file.btoa btoa: Repair output to 'btoa.rep'.
  101.      Remote> transmit btoa.rep
  102.  
  103.      Local> btoa -a btoa.rep btoa: Repaired  archive  written  to
  104.      'btoa.rdy'.
  105.  
  106.      You can now erase file.btoa and decode btoa.rdy using  'btoa
  107.      -a btoa.rdy'.
  108.  
  109. AUTHORS
  110.      Paul Rutter  Joe Orost  Stefan Parmark
  111.  
  112. KNOWN BUGS
  113.      Btoa will not work properly unless the input is a true  file
  114.      or a redirected one. This is because file positions are col-
  115.      lected during diagnosis for later reference  when  producing
  116.      the  diagnosis  file.   The bug is actually in fseek() which
  117.      only can reposition 'real' files.
  118.  
  119.      Send bug reports to d84sp@efd.lth.se (Stefan Parmark).
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                   Last change: 21 February 1989                 2
  130.  
  131.  
  132.  
  133.